Game Programming in C++ - Start to Finish

home *** CD-ROM | disk | FTP | other *** search

/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUIEditbox.h < prev next >

Wrap

C/C++ Source or Header | 2005-06-04 | 20.8 KB | 716 lines

/************************************************************************ filename: CEGUIEditbox.h created: 13/4/2004 author: Paul D Turner purpose: Interface to base class for Editbox widget *************************************************************************/ /************************************************************************* Crazy Eddie's GUI System (http://www.cegui.org.uk) Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *************************************************************************/ #ifndef _CEGUIEditbox_h_ #define _CEGUIEditbox_h_ #include "CEGUIBase.h" #include "CEGUIWindow.h" #include "elements/CEGUIEditboxProperties.h" #if defined(_MSC_VER) # pragma warning(push) # pragma warning(disable : 4251) #endif // Start of CEGUI namespace section namespace CEGUI { // forward declare implementation data type struct RegexValidator; /*! \brief Base class for an Editbox widget */ class CEGUIEXPORT Editbox : public Window { public: static const String EventNamespace; //!< Namespace for global events /************************************************************************* Constants *************************************************************************/ // default colours static const argb_t DefaultNormalTextColour; //!< Colour applied to normal unselected text. static const argb_t DefaultSelectedTextColour; //!< Colour applied to selected text. static const argb_t DefaultNormalSelectionColour; //!< Colour applied to normal selection brush. static const argb_t DefaultInactiveSelectionColour; //!< Colour applied to selection brush when widget is inactive. /************************************************************************* Event name constants *************************************************************************/ static const String EventReadOnlyModeChanged; //!< The read-only mode for the edit box has been changed. static const String EventMaskedRenderingModeChanged; //!< The masked rendering mode (password mode) has been changed. static const String EventMaskCodePointChanged; //!< The code point (character) to use for masked text has been changed. static const String EventValidationStringChanged; //!< The validation string has been changed. static const String EventMaximumTextLengthChanged; //!< The maximum allowable string length has been changed. static const String EventTextInvalidated; //!< Some operation has made the current text invalid with regards to the validation string. static const String EventInvalidEntryAttempted; //!< The user attempted to modify the text in a way that would have made it invalid. static const String EventCaratMoved; //!< The text carat (insert point) has changed. static const String EventTextSelectionChanged; //!< The current text selection has changed. static const String EventEditboxFull; //!< The number of characters in the edit box has reached the current maximum. static const String EventTextAccepted; //!< The user has accepted the current text by pressing Return, Enter, or Tab. /************************************************************************* Accessor Functions *************************************************************************/ /*! \brief return true if the Editbox has input focus. \return true if the Editbox has keyboard input focus, false if the Editbox does not have keyboard input focus. */ bool hasInputFocus(void) const; /*! \brief return true if the Editbox is read-only. \return true if the Editbox is read only and can't be edited by the user, false if the Editbox is not read only and may be edited by the user. */ bool isReadOnly(void) const {return d_readOnly;} /*! \brief return true if the text for the Editbox will be rendered masked. \return true if the Editbox text will be rendered masked using the currently set mask code point, false if the Editbox text will be rendered as plain text. */ bool isTextMasked(void) const {return d_maskText;} /*! \brief return true if the Editbox text is valid given the currently set validation string. \note It is possible to programmatically set 'invalid' text for the Editbox by calling setText. This has certain implications since if invalid text is set, whatever the user types into the box will be rejected when the input is validated. \note Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation. \return true if the current Editbox text passes validation, false if the text does not pass validation. */ bool isTextValid(void) const; /*! \brief return the currently set validation string \note Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation. \return String object containing the current validation regex data */ const String& getValidationString(void) const {return d_validationString;} /*! \brief return the current position of the carat. \return Index of the insert carat relative to the start of the text. */ size_t getCaratIndex(void) const {return d_caratPos;} /*! \brief return the current selection start point. \return Index of the selection start point relative to the start of the text. If no selection is defined this function returns the position of the carat. */ size_t getSelectionStartIndex(void) const; /*! \brief return the current selection end point. \return Index of the selection end point relative to the start of the text. If no selection is defined this function returns the position of the carat. */ size_t getSelectionEndIndex(void) const; /*! \brief return the length of the current selection (in code points / characters). \return Number of code points (or characters) contained within the currently defined selection. */ size_t getSelectionLength(void) const; /*! \brief return the utf32 code point used when rendering masked text. \return utf32 code point value representing the Unicode code point that will be rendered instead of the Editbox text when rendering in masked mode. */ utf32 getMaskCodePoint(void) const {return d_maskCodePoint;} /*! \brief return the maximum text length set for this Editbox. \return The maximum number of code points (characters) that can be entered into this Editbox. \note Depending on the validation string set, the actual length of text that can be entered may be less than the value returned here (it will never be more). */ size_t getMaxTextLength(void) const {return d_maxTextLen;} /*! \brief return the currently set colour to be used for rendering Editbox text in the normal, unselected state. \return colour value describing the ARGB colour that is currently set. */ colour getNormalTextColour(void) const {return d_normalTextColour;} /*! \brief return the currently set colour to be used for rendering the Editbox text when within the selected region. \return colour value describing the ARGB colour that is currently set. */ colour getSelectedTextColour(void) const {return d_selectTextColour;} /*! \brief return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is active. \return colour value describing the ARGB colour that is currently set. */ colour getNormalSelectBrushColour(void) const {return d_selectBrushColour;} /*! \brief return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. \return colour value describing the ARGB colour that is currently set. */ colour getInactiveSelectBrushColour(void) const {return d_inactiveSelectBrushColour;} /************************************************************************* Manipulators *************************************************************************/ /*! \brief Specify whether the Editbox is read-only. \param setting true if the Editbox is read only and can't be edited by the user, false if the Editbox is not read only and may be edited by the user. \return Nothing. */ void setReadOnly(bool setting); /*! \brief Specify whether the text for the Editbox will be rendered masked. \param setting true if the Editbox text should be rendered masked using the currently set mask code point, false if the Editbox text should be rendered as plain text. \return Nothing. */ void setTextMasked(bool setting); /*! \brief Set the text validation string. \note Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation. \param validation_string String object containing the validation regex data to be used. \return Nothing. */ void setValidationString(const String& validation_string); /*! \brief Set the current position of the carat. \param carat_pos New index for the insert carat relative to the start of the text. If the value specified is greater than the number of characters in the Editbox, the carat is positioned at the end of the text. \return Nothing. */ void setCaratIndex(size_t carat_pos); /*! \brief Define the current selection for the Editbox \param start_pos Index of the starting point for the selection. If this value is greater than the number of characters in the Editbox, the selection start will be set to the end of the text. \param end_pos Index of the ending point for the selection. If this value is greater than the number of characters in the Editbox, the selection end will be set to the end of the text. \return Nothing. */ void setSelection(size_t start_pos, size_t end_pos); /*! \brief set the utf32 code point used when rendering masked text. \param code_point utf32 code point value representing the Unicode code point that should be rendered instead of the Editbox text when rendering in masked mode. \return Nothing. */ void setMaskCodePoint(utf32 code_point); /*! \brief set the maximum text length for this Editbox. \param max_len The maximum number of code points (characters) that can be entered into this Editbox. \note Depending on the validation string set, the actual length of text that can be entered may be less than the value set here (it will never be more). \return Nothing. */ void setMaxTextLength(size_t max_len); /*! \brief Set the colour to be used for rendering Editbox text in the normal, unselected state. \param col colour value describing the ARGB colour that is to be used. \return Nothing. */ void setNormalTextColour(const colour& col); /*! \brief Set the colour to be used for rendering the Editbox text when within the selected region. \return colour value describing the ARGB colour that is currently set. */ void setSelectedTextColour(const colour& col); /*! \brief Set the colour to be used for rendering the Editbox selection highlight when the Editbox is active. \param col colour value describing the ARGB colour that is to be used. \return Nothing. */ void setNormalSelectBrushColour(const colour& col); /*! \brief Set the colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. \param col colour value describing the ARGB colour that is to be used. \return Nothing. */ void setInactiveSelectBrushColour(const colour& col); /************************************************************************* Construction / Destruction *************************************************************************/ /*! \brief Constructor for Editbox class. */ Editbox(const String& type, const String& name); /*! \brief Destructor for Editbox class. */ virtual ~Editbox(void); protected: /************************************************************************* Implementation functions *************************************************************************/ /*! \brief Add edit box specific events */ void addEditboxEvents(void); /*! \brief Return the text code point index that is rendered closest to screen position \a pt. \param pt Point object describing a position on the screen in pixels. \return Code point index into the text that is rendered closest to screen position \a pt. */ virtual size_t getTextIndexFromPosition(const Point& pt) const = 0; /*! \brief Clear the current selection setting */ void clearSelection(void); /*! \brief Erase the currently selected text. \param modify_text when true, the actual text will be modified. When false, everything is done except erasing the characters. */ void eraseSelectedText(bool modify_text = true); /*! \brief return true if the given string matches the validation regular expression. */ bool isStringValid(const String& str) const; /*! \brief Processing for backspace key */ void handleBackspace(void); /*! \brief Processing for Delete key */ void handleDelete(void); /*! \brief Processing to move carat one character left */ void handleCharLeft(uint sysKeys); /*! \brief Processing to move carat one word left */ void handleWordLeft(uint sysKeys); /*! \brief Processing to move carat one character right */ void handleCharRight(uint sysKeys); /*! \brief Processing to move carat one word right */ void handleWordRight(uint sysKeys); /*! \brief Processing to move carat to the start of the text. */ void handleHome(uint sysKeys); /*! \brief Processing to move carat to the end of the text */ void handleEnd(uint sysKeys); /*! \brief Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. \param class_name The class name that is to be checked. \return true if this window was inherited from \a class_name. false if not. */ virtual bool testClassName_impl(const String& class_name) const { if (class_name==(const utf8*)"Editbox") return true; return Window::testClassName_impl(class_name); } /************************************************************************* New event handlers *************************************************************************/ /*! \brief Event fired internally when the read only state of the Editbox has been changed */ virtual void onReadOnlyChanged(WindowEventArgs& e); /*! \brief Event fired internally when the masked rendering mode (password mode) has been changed */ virtual void onMaskedRenderingModeChanged(WindowEventArgs& e); /*! \brief Event fired internally when the code point to use for masked rendering has been changed. */ virtual void onMaskCodePointChanged(WindowEventArgs& e); /*! \brief Event fired internally when the validation string is changed. */ virtual void onValidationStringChanged(WindowEventArgs& e); /*! \brief Event fired internally when the maximum text length for the edit box is changed. */ virtual void onMaximumTextLengthChanged(WindowEventArgs& e); /*! \brief Event fired internally when something has caused the current text to now fail validation This can be caused by changing the validation string or setting a maximum length that causes the current text to be truncated. */ virtual void onTextInvalidatedEvent(WindowEventArgs& e); /*! \brief Event fired internally when the user attempted to make a change to the edit box that would have caused it to fail validation. */ virtual void onInvalidEntryAttempted(WindowEventArgs& e); /*! \brief Event fired internally when the carat (insert point) position changes. */ virtual void onCaratMoved(WindowEventArgs& e); /*! \brief Event fired internally when the current text selection changes. */ virtual void onTextSelectionChanged(WindowEventArgs& e); /*! \brief Event fired internally when the edit box text has reached the set maximum length. */ virtual void onEditboxFullEvent(WindowEventArgs& e); /*! \brief Event fired internally when the user accepts the edit box text by pressing Return, Enter, or Tab. */ virtual void onTextAcceptedEvent(WindowEventArgs& e); /************************************************************************* Overridden event handlers *************************************************************************/ virtual void onMouseButtonDown(MouseEventArgs& e); virtual void onMouseButtonUp(MouseEventArgs& e); virtual void onMouseDoubleClicked(MouseEventArgs& e); virtual void onMouseTripleClicked(MouseEventArgs& e); virtual void onMouseMove(MouseEventArgs& e); virtual void onCaptureLost(WindowEventArgs& e); virtual void onCharacter(KeyEventArgs& e); virtual void onKeyDown(KeyEventArgs& e); virtual void onTextChanged(WindowEventArgs& e); /************************************************************************* Implementation data *************************************************************************/ bool d_readOnly; //!< True if the editbox is in read-only mode bool d_maskText; //!< True if the editbox text should be rendered masked. utf32 d_maskCodePoint; //!< Code point to use when rendering masked text. size_t d_maxTextLen; //!< Maximum number of characters for this Editbox. size_t d_caratPos; //!< Position of the carat / insert-point. size_t d_selectionStart; //!< Start of selection area. size_t d_selectionEnd; //!< End of selection area. String d_validationString; //!< Copy of validation reg-ex string. RegexValidator* d_validator; //!< RegEx String used for validation of text. bool d_dragging; //!< true when a selection is being dragged. size_t d_dragAnchorIdx; //!< Selection index for drag selection anchor point. // basic rendering colours colour d_normalTextColour; //!< Text colour used normally. colour d_selectTextColour; //!< Text colour used when text is highlighted colour d_selectBrushColour; //!< Colour to apply to the selection brush. colour d_inactiveSelectBrushColour; //!< Colour to apply to the selection brush when widget is inactive / read-only. private: /************************************************************************* Static Properties for this class *************************************************************************/ static EditboxProperties::ReadOnly d_readOnlyProperty; static EditboxProperties::MaskText d_maskTextProperty; static EditboxProperties::MaskCodepoint d_maskCodepointProperty; static EditboxProperties::ValidationString d_validationStringProperty; static EditboxProperties::CaratIndex d_caratIndexProperty; static EditboxProperties::SelectionStart d_selectionStartProperty; static EditboxProperties::SelectionLength d_selectionLengthProperty; static EditboxProperties::MaxTextLength d_maxTextLengthProperty; static EditboxProperties::NormalTextColour d_normalTextColourProperty; static EditboxProperties::SelectedTextColour d_selectedTextColourProperty; static EditboxProperties::ActiveSelectionColour d_activeSelectionColourProperty; static EditboxProperties::InactiveSelectionColour d_inactiveSelectionColourProperty; /************************************************************************* Private methods *************************************************************************/ void addEditboxProperties(void); }; } // End of CEGUI namespace section #if defined(_MSC_VER) # pragma warning(pop) #endif #endif // end of guard _CEGUIEditbox_h_